package MapOrganising;

/**
 * Used to hold the name and catogory of individual mind maps.
 * 
 * @author Lewis Marhin and John Gray-Spence
 */
public class ListObject {
    String fname = null;
    String map = null;
    String cats = null;
    String rating = null;

    /**
     * Initializes a MasterListObject object.
     *
     * @param f The file name to be stored.
     * @param m The file contents to be stored.
     * @param c The catagories the file pertains to.
     * @param r The maps relevance rating.
     */
    ListObject( String f, String m, String c, String r ) {
        fname = f;
        map = m;
        cats = c;
        rating = r;
    }

    /**
     * Retrieve the name of a file.
     *
     * @return String containing name of mindmap.
     */
    public String getFname() {
        return fname;
    }

    /**
     * Retrieve a mindmap.
     *
     * @return String containing contents of a mindmap file.
     */
    public String getMap() {
        return map;
    }

    /**
     * Retrieve the catagories the mindmap belongs to.
     *
     * @return String containing DELIMITER_CAT sperated catagories.
     */
    public String getCat() {
        return cats;
    }

    /**
     * Retrieve the relevance rating of the mind map.
     *
     * @return String containing the number 1, 2, 3, 4 or 5.
     */
    public String getRating() {
        return rating;
    }
}
